home *** CD-ROM | disk | FTP | other *** search
/ World of Education / World of Education.iso / world_p / pcshx10b.zip / PCSHX10B.EXE / UTILS.EXE / UTILDOCS.EXE / GET.DOC < prev    next >
Text File  |  1989-08-30  |  8KB  |  118 lines
  1.  
  2.     GET -- Bob Stephan's Batch file enhancer -- a public domain utility
  3.            Syntax:  GET command argument
  4.   Purpose             Command       Argument   Environment Errorlevel  Extended
  5.   ---------           -------       --------   --(GET=)--- --(Exit)--  --[E]---
  6.   Get character       C[E] ["prompt"] [chars]  Character   ASCII dec.  No Echo
  7.   Get yes/no aNswer   N[E] ["prompt"]  None    Character   ASCII dec.  No Echo
  8.   Get string          S[E] ["prompt"]  None    String      Length      No Echo
  9.   Moving Text(GetaKey)T[E] "Filespec" [chars]  Character   ASCII dec.  No Echo
  10.   Get DOS version     D[E]             None    Major Vers. MajorMinor  MinorEnv
  11.   Get environment left    E[E]         None    Bytes left  Bytes left  Bytes/10
  12.   Get file size (0=DIR)   F[E]  Filespec       Hex bytes   Kilobytes   Kb/10
  13.   Get disk space          K[E] [driveletter]   Kilobytes   Kilobytes   Kb/10
  14.   Get memory free         M[E]         None    Kilobytes   Kilobytes   Kb/10
  15.   Clear (Blank) Screen    B   [New attribute]  Current or last attr.   None
  16.   Check for printer       P            None    1=yes,0=no  1=yes,0=no  None
  17.   Get/set video mode      V   [New mode]       Current or last mode    None
  18.   Check coprocessor       7            None    1=yes,0=no  1=yes,0=no  None
  19.   Check for ANSI.SYS      A            None    1=yes,0=no  1=yes,0=no  None
  20.   Get current directory   Y            None    Directory   Level/Drive Drive
  21.   Surrogate character args: } is Carriage Return, ~ is Escape, ` is Extended.
  22.  
  23.   Explanations:
  24.     To display the above screen, enter GET with no arguments, or GET ?.
  25.     C, Commands are single characters or a character and [optionally] E with
  26.        no spaces between.  The E indicates the Extended function above.
  27.     N, the yes/No answer will accept y,Y,n,N, carriage return, or Esc.
  28.     B, the screen Blanker, does not change your color settings unless
  29.        you give it an attribute to use, and it will work with any number
  30.        of lines on the screen (e.g. EGA 43 or VGA 50).
  31.     [] brackets indicate optional portions of commands and/or arguments. The
  32.        command will work regardless whether these portions are included or not.
  33.     Where double quotes ("'s) are shown, they must be included as shown
  34.        if the corresponding command/argument is used.
  35.     A filespec may include drive and path but no wild cards.
  36.     [chars] are optional characters that limit the user input to just
  37.        the characters given.  This should be a contiguous character
  38.        string separated from the prompt, if given, by a space.
  39.        Single characters are taken without pressing Enter.
  40.        (Strings, of course, will require the user to press Enter.)
  41.        The comparison of characters is not case sensitive.  To
  42.        indicate that a carriage return, Esc, or Extended key is
  43.        acceptable, include the surrogate character listed above.  CR and Esc
  44.        will return 125 and 126 in the errorlevel respectively.  If
  45.        no chars are given, any key stroke will be accepted.  If extended
  46.        keyboard characters are specified, the scan code will be in the
  47.        errorlevel and the corresponding ASCII byte in the environment
  48.        preceeded by "`".  A table of keyboard scan codes will be useful.
  49.     Environment: this column indicates what will be found in the
  50.        environment string GET=.  This string can be accessed from a
  51.        BATch file with the %GET% notation.
  52.     Errorlevel: this column indicates what value will be placed in the
  53.        DOS errorlevel that can be accessed in BATch files with the
  54.        "if errorlevel" subcommand.
  55.     Extended: this column indicates the action taken if the optional
  56.        "E"xtended command is included.  The values/10 refer to errorlevel
  57.        return codes reduced by a factor of 10, useful for large values.
  58.        The drive for the Y command will be in both places.  The minor DOS
  59.        version (e.g., the 1 in 3.1) will be in the environment, but the
  60.        errorlevel will have (major*10)+minor in either case (e.g. 31).
  61.     T, the Moving Text feature, requires a file with the prompt string that
  62.        will be displayed moving across the bottom line of the screen.
  63.        Currently only standard 25 line screens are supported.  The text
  64.        file should be plain ASCII without any control characters (No CR,
  65.        LF, or any other characters below ASCII 32).  To be effective
  66.        the prompt must be over 80 characters long, and to ensure
  67.        smooth wrap-around the first 79 characters should be repeated
  68.        at the end.  The maximum length for the text of the moving
  69.        prompt is 4096 characters.  Over that it will be truncated.
  70.        Use COPY CON to create text and end with an F6. For small files of less 
  71.        than 79 chars, copy the file to itself as necessary .  ie; 
  72.                 copy filename.one+filename.one filename.two
  73.  
  74.     V: don't fool around with Video mode unless you know what you're doing!
  75.  
  76.    You may want to clear GET from the environment at the end of the .BAT file 
  77.    with GET=
  78.  
  79.    GET is programmmed in assembly language for MS-DOS computers. If you need
  80.    more BATch programming capability than is included here, I suggest you
  81.    look into the Shareware product, Extended Batch Language or EBL. However,
  82.    you will probably have to pay a licensing fee for EBL, and GET is FREE!
  83.    Portions of the code for GET were adapted from the sample program named
  84.    WHAT.ASM included with Microsoft Macro Assembler (MASM). The MASM
  85.    documentation declares that the sample programs are in the public domain.
  86.    For examples of GET, look at the BATch files on the MASDIR disk for the
  87.    use of a similar program called SDL_GET. You can do a lot in BATch
  88.    programming with this utility. It remains in the public domain for all to
  89.    enjoy.                               /s/Bob Stephan          May 23, 1989
  90.  
  91.     If you have any questions, comments, or suggestions please contact me at:
  92.          MOBY DISK: 1021 San Carlos Road, Pebble Beach, CA 93953
  93.     Phone: (408) 646-1899, 646-1373.  GENIE:MOBYDISK.  COMPUSERVE:72357,2276
  94.  
  95.       Now for the commercial: If you like GET you will love MASDIR!
  96.    MASDIR (pronounced 'master') the MASter DIRectory System, is a general
  97.    purpose sorted directory program with unique disk label printing and
  98.    customization features. If you ever use DIR, you should do yourself a
  99.    favor and take a look at MASDIR. The main program, SDL.COM, is one of the
  100.    best sorted directory programs anywhere. The setup program allows you to
  101.    set the many defaults to your own specifications, including customizing
  102.    the titles that appear in the header. In addition, you can print disk
  103.    labels and or sleeve inserts for 5.25" and 3.5" diskettes. This really
  104.    saves you a lot of time when you are looking through your collection of
  105.    diskettes for a particular file. They are all listed conveniently along
  106.    with your own description in the title lines. You can also create disk
  107.    file catalogs of your diskettes and directories that you can then
  108.    annotate to describe individual files.
  109.  
  110.    As of the above date, the current release of MASDIR is Version 4.3. It is
  111.    a shareware program that is available on bulletin boards, GENIE,
  112.    CompuServe, The Public (software) Library, and from other distributors of
  113.    public domain and shareware programs. If you cannot conveniently locate a
  114.    copy, I will be happy to send you one. Just contact me as indicated
  115.    above. Thank you for your kind attention. /Bob/
  116.  
  117.  
  118.